<!DOCTYPE html>
<html>
	<title>Chatty Help</title>
        <link rel="stylesheet" type="text/css" href="style.css" />
        <style type="text/css">
            .fileComment {
                color: gray;
            }
            .fileCommentFolder {
               
            }
            .filesT {
                font-family: Monospace;
                margin: 10px 0 14px 0;
            }
            .filesT td {
                margin: 0;
                padding: 0;
                padding-right: 5px;
                padding-top: 2px;
            }
            
        </style>
<body>
    <div id="backlink"><a href="help.html">Back to main help page</a></div>
    <h1><a name="top">Guide: Settings and other files</a></h1>
    <p>
        <a href="#files">Files / Directory structure</a> |
        <a href="#uninstall">Uninstall</a> |
        <a href="#backup">Backup</a>
    </p>
    <p>Learn what directories and files Chatty creates/uses.</p>

    <h2><a name="files">Files / Directory structure</a></h2>
    <h3><a name="settings-dir">Settings Directory</a></h3>
        <p>The settings directory by default is in your user home directory in a
            subdirectory called <code>.chatty</code>. You can enter the command
            <code>/dir</code> to display and <code>/openDir</code> to open the
            settings directory that Chatty currently uses.</p>
        
        <p>If you want to replace, copy or delete setting files in any way, make
            sure to close Chatty before doing so (the files may be overwritten
            at any time while Chatty is running).</p>

        <p>You can change the settings directory via different ways:</p>
        
        <ul>
            <li>The <code>-cd</code> launch option changes the settings
                directory to the current <a href="#wdir">working directory</a>.</li>
            <li>The <code>-d &lt;dir&gt;</code> launch option changes the settings
                directory to the specified directory (which must already exist).
                Example: <code>-d D:\program settings\Chatty</code> (no quotes)</li>
            <li>The <code>-portable</code> launch option changes the settings
                directory to a directory called <code>portable_settings</code>
                created next to the <code>Chatty.jar</code>.</li>
        </ul>
        
        <p>You can use launch options by adding them to <a href="help-guide_create_shortcut.html">a shortcut</a>
            or (if you're using the standalone version) by adding it to the <a href="help-standalone.html#cfg-launch">Chatty.cfg</a>.</p>
        
    <table class="filesT">
        <tr>
            <td>&lt;settings directory&gt;</td>
            <td></td>
        </tr>
        <tr>
            <td>|-- backup</td>
            <td class="fileCommentFolder">[Directory]</td>
        </tr>
        <tr>
            <td>|&nbsp; &nbsp;|- auto_*</td>
            <td class="fileComment">Automatic setting <a href="#backup">backups</a></td>
        </tr>
        <tr>
            <td>|&nbsp; &nbsp;|- manual_*</td>
            <td class="fileComment">Manual setting backups</td>
        </tr>
        <tr>
            <td>|&nbsp; &nbsp;|- session_*</td>
            <td class="fileComment">Session setting backups</td>
        </tr>
        <tr>
            <td>|&nbsp; &nbsp;|- <span class="del">backup_*</span></td>
            <td class="fileComment">Old backups (no longer used)</td>
        </tr>
        <tr>
            <td>|</td>
            <td></td>
        </tr>
        <tr>
            <td>|-- cache</td>
            <td class="fileCommentFolder">[Directory] (<a href="#customize">customize</a>)</td>
        </tr>
        <tr>
            <td>|&nbsp; &nbsp;|- &lt;cache files&gt;</td>
            <td class="fileComment">Cached emotes/image files</td>
        </tr>
        <tr>
            <td>|</td>
            <td></td>
        </tr>
        <tr>
            <td>|-- debuglogs</td>
            <td class="fileCommentFolder">[Directory] (<a href="#customize">customize</a>)</td>
        </tr>
        <tr>
            <td>|&nbsp; &nbsp;|- &lt;debug files&gt;</td>
            <td class="fileComment">See <a href="help-report_issue.html#log">Debug Log</a></td>
        </tr>
        <tr>
            <td>|</td>
            <td></td>
        </tr>
        <tr>
            <td>|-- exported</td>
            <td class="fileCommentFolder">[Directory] (<a href="#customize">customize</a>)</td>
        </tr>
        <tr>
            <td>|&nbsp;&nbsp;&nbsp;|-&nbsp;stream_highlights.txt</td>
            <td class="fileComment">Recorded <a href="help.html#streamhighlights">stream highlights</a></td>
        </tr>
        <tr>
            <td>|&nbsp;&nbsp;&nbsp;|-&nbsp;&lt;exported text&gt;</td>
            <td class="fileComment"><a href="help-builtin_commands.html#commands-system">/exportText command</a> output</td>
        </tr>
        <tr>
            <td>|</td>
            <td></td>
        </tr>
        <tr>
            <td>|-- logs</td>
            <td class="fileCommentFolder">[Directory] (<a href="#customize">customize</a>)</td>
        </tr>
        <tr>
            <td>|&nbsp; &nbsp;|- &lt;log files&gt;</td>
            <td class="fileComment">Chat log files</td>
        </tr>
        <tr>
            <td>|</td>
            <td></td>
        </tr>
        <tr>
            <td>|- login</td>
            <td class="fileComment">[Settings] Your login data (keep this secure)</td>
        </tr>
        
        <tr>
            <td>|- settings</td>
            <td class="fileComment">[Settings] Main Settings File</td>
        </tr>
        <tr>
            <td>|- <span class="del">addressbook</span></td>
            <td class="fileComment">[Settings] <a href="help-addressbook.html">Addressbook</a> entries [deprecated]</td>
        </tr>
        <tr>
            <td>|- <span class="del">favoritesAndHistory</span></td>
            <td class="fileComment">[Settings] Channel History/Favorites [deprecated]</td>
        </tr>
        <tr>
            <td>|- <span class="del">statusPresets</span></td>
            <td class="fileComment">[Settings] Stream Title/Game presets (Admin Dialog) [deprecated]</td>
        </tr>
        
    </table>
    
    <p><em>Note:</em> <code>favoritesAndHistory</code> and <code>statusPresets</code>
        have been merged into <code>settings</code> as of v0.9.1.
        The <code>addressbook</code> has been merged into <code>settings</code>
        as of v0.12 (but may still be written to under some circumstances).</p>
    
    <h3><a name="wdir">Working Directory</a></h3>
    <p>This directory is associated with Chatty when you start it. This is
        usually the directory the program is started from. When using the
        standalone (Chatty.exe) this is always set to the "app" directory of
        the standalone bundle. In some cases, depending on how Chatty is
        started, this may point to a different directory.</p>
    
    <p>You can change the Working Directory by specifying it when you start
        Chatty, usually by <a href="help-guide_create_shortcut.html">creating a shortcut</a>
        and changing what is defined under <code>Run in</code> in the shortcut
        settings. Make sure this points to the same folder the <code>Chatty.jar</code>
        is in (or something else if you want to customize it, just make sure the
        files you need are there).</p>

    <p>Use the command <code>/wdir</code> to display and <code>/openWdir</code>
        to open the Working Directory.</p>
    
        <table class="filesT">
        <tr>
            <td>&lt;working directory&gt;</td>
            <td></td>
        </tr>
        <tr>
            <td>|-- sounds</td>
            <td class="fileCommentFolder">[Folder] Sound files for Notifications (<a href="#customize">customize</a>)</td>
        </tr>
        <tr>
            <td>|&nbsp; &nbsp;|- &lt;sound&gt;.wav</td>
            <td class="fileComment">.wav files</td>
        </tr>
        <tr>
            <td>|-- img</td>
            <td class="fileCommentFolder">[Folder] Image files for Custom Badges (<a href="#customize">customize</a>)</td>
        </tr>
        <tr>
            <td>|&nbsp;&nbsp;&nbsp;|-&nbsp;&lt;various&nbsp;images&gt;</td>
            <td class="fileComment">.png files</td>
        </tr>
    </table>
    
    <h3>JAR Location</h3>
    <p>This is where the Chatty.jar is located and is used for loading libraries
    that Chatty uses.</p>
    
    <h3><a name="customize">Customize</a></h3>
    <p>Some folders can be changed:</p>
    <ul>
        <li>Settings directory: See <a href="#settings-dir">Settings Directory</a>
            (this one also affects the default location of some other folders)</li>
        <li>Debuglogs: Using the <code>-debugdir</code> <a href="help.html#launch">launch option</a></li>
        <li>Logs: In the Settings under "Log to file"</li>
        <li>Cache: In the Settings under "Other"</li>
        <li>Exported files: In the Settings under "Other"</li>
        <li>Images: In the Settings under "Other"</li>
        <li>Sounds: In the Settings under "Notifications"</li>
    </ul>
    
    <p>Changing folders usually requires a restart of Chatty to be properly
        applied.</p>
    
    <h2><a name="uninstall">Uninstall</a></h2>
    <p>To remove Chatty from your computer:</p>
    
    <ul>
        <li>Locate your settings directory by entering <code>/openDir</code> in
            Chatty. If you customized your Chatlog or Sounds directory you may
            want to find those in the Settings.</li>
        <li>Close Chatty.</li>
        <li>Delete the directory where Chatty is installed (where the <code>Chatty.exe</code>
            or <code>Chatty.jar</code> are located) and the settings directory.</li>
    </ul>
    
    <h2><a name="backup">Backup</a></h2>
    <p>Setting backups can provide a way to recover your settings if the
        setting weren't written or loaded properly or to reset your settings
        to a previous state.</p>
    
    <p>Chatty can perform these types of backups:</p>
    <ul>
        <li>Session backup (<code>session_*</code>): A copy of the currenty written settings, which is
            mostly intended as a fallback if the main settings file cannot be
            written. This changes often, so loading it only makes sense
            immediately after starting Chatty, before settings are saved again.</li>
        <li>Backup on start (<code>auto_*</code>): A copy of the settings file, made when Chatty is
            started. By default a backup is made no more often than one day
            apart and only a limited number of backups are kept.</li>
        <li>Manual backup (<code>manual_*</code>): You can create a manual backup via "Main - Save..".
            Manual backups are never automatically deleted.</li>
    </ul>
    <p><em>Note:</em> The <code>login</code> settings file is not backed up.
    For a safer backup, make your own backups on a different
        device.</p>
    
    <p>To load an automatic backup go to "Main - Settings - Main - View Backups"
        and follow the instructions. If you want to restore a manual backup you made of the
        <code>settings</code> file, simply overwrite the current <code>settings</code>
        file while Chatty is not running.</p>
    
    <p>You can view the backup directory directly by entering <code>/openBackupDir</code>
        or <code>/showBackupDir</code> into the Chatty inputbox. Note that files
        in the backup directory starting with <code>auto_</code> may be automatically
        deleted.</p>

</body>
</html>

